Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed typos in docs (squashed version of #1600) #1602

Merged
merged 1 commit into from Dec 16, 2012

Conversation

kdavies4
Copy link
Contributor

No description provided.

@dmcdougall
Copy link
Member

Thanks @kdavies4. Merging.

dmcdougall added a commit that referenced this pull request Dec 16, 2012
Fixed typos in docs (squashed version of #1600)
@dmcdougall dmcdougall merged commit 5ec4079 into matplotlib:master Dec 16, 2012
@mdboom
Copy link
Member

mdboom commented Dec 17, 2012

Great work! I wonder if it would be possible to adapt your script to work on docstrings and run over the source code as well... There's probably a lot more to ignore there (i.e. more manual work) but I suspect there's a lot of typos there, too.

@@ -730,14 +730,14 @@ Here are the 0.98.4 notes from the CHANGELOG::
Added mdehoon's native macosx backend from sf patch 2179017 - JDH

Removed the prints in the set_*style commands. Return the list of
pprinted strings instead - JDH
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I think this was supposed to be "pprinted" as in "import pprint".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @WeatherGod is right -- maybe we change this to read "pretty-printed strings instead"?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad. See #1605.

@kdavies4
Copy link
Contributor Author

@mdboom, Thanks. I put the script and custom dictionaries at the link below. All three files should go in the base folder of matplotlib.

It's nothing elaborate, but maybe it could be expanded. I just ran the script over many of the subfolders of matplotlib/doc by editing the first line of the script. When a string isn't recognized, I add it (press "a") if it is a special variable name or other valid string or ignore it (press "i") if it is a misspelled word. Once I've checked all of the matching files (or gotten tired), I exit the script and rerun it. On the second pass, only the misspelled words appear. I find and fix them in the source code.

There are a lot of words to pass through. Sometimes I go too fast and realize that I hit "a" for a misspelled word. aspell doesn't seem to put the new words at the end of the custom dictionary, so it's hard to find and delete the mispelled word from the dictionary. I split the dictionary in two parts so that the new words are added to a smaller file (.matplotlib_new.pws).

https://www.dropbox.com/sh/nedfkbn31j3zpng/KtKzC4hrWy/spellcheck

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants